Multi-file Swift Output by MrRooni · Pull Request #1221 · glideapps/quicktype

MrRooni · 2019-05-07T12:30:56Z

Reason to Be

When running quicktype to generate Swift code from a directory of schema files the output currently dumps everything into a single .swift file. This PR breaks each named type out into its own file. Additionally it generates a JSONSchemaSupport.swift that contains many of the helper functions needed by the various outputs.

Resolves #687

CHANGELOG Entry

[IMPROVED] Generating Swift files from a directory of inputs now outputs one Swift file per top level schema object.

Thought Process

After seeing that the Java renderer already does this exact thing and digging into how quicktype writes its files I began refactoring the renderer to divide up the generated source into sensible blocks.

How To Test

Testing manually should be as simple as:

quicktype . -l Swift -s schema -o .

Possible Impacts

I know for a fact that I've broken the rendering of one of the schema inputs. shakes fist at keyword-unions.schema

I'll be working to get that fixed up…somehow.

It’s not strictly true unless you also specify Objective-C support, but harmless nonetheless.

MrRooni · 2019-05-07T12:33:53Z

Throwing an informal wait tag on this one. Need to tidy up a couple things first, but wanted to see how the tests turn out from the server.

…o/new/multi-file-output # Conflicts: # src/quicktype-core/language/Swift.ts

schani · 2019-05-07T13:04:49Z

Looks like the emitted code is incorrect:

main.swift:12:28: error: value of optional type 'TopLevel?' not unwrapped; did you mean to use '!' or '?'?
  | guard let jsonString = try obj.jsonString() else {
  | ^
  | ?
  |  
  | Fixture threw an exception
  | {
  | "error": {
  | "command": "swiftc -o quicktype main.swift quicktype.swift",
  | "code": 1
  | },
  | "sample": {
  | "path": "test/inputs/json/priority/combinations1.json",
  | "additionalRendererOptions": {
  | "support-linux": "false"
  | },
  | "saveOutput": false
  | },
  | "cwd": "/app/test/runs/swift-4f7779"
  | }
  |  
  | main.swift:12:28: error: value of optional type 'TopLevel?' not unwrapped; did you mean to use '!' or '?'?
  | guard let jsonString = try obj.jsonString() else {
  | ^
  | ?
  |  
  | Fixture threw an exception
  | {
  | "error": {
  | "command": "swiftc -o quicktype main.swift quicktype.swift",
  | "code": 1
  | },
  | "sample": {
  | "path": "test/inputs/json/priority/combinations2.json",
  | "additionalRendererOptions": {
  | "support-linux": "false"
  | },
  | "saveOutput": false
  | },
  | "cwd": "/app/test/runs/swift-031586"
  | }
  |  
  | main.swift:12:28: error: value of optional type 'TopLevel?' not unwrapped; did you mean to use '!' or '?'?
  | guard let jsonString = try obj.jsonString() else {
  | ^
  | ?
  |  
  | Fixture threw an exception
  | {
  | "error": {
  | "command": "swiftc -o quicktype main.swift quicktype.swift",
  | "code": 1
  | },
  | "sample": {
  | "path": "test/inputs/json/priority/combinations3.json",
  | "additionalRendererOptions": {
  | "support-linux": "false"
  | },
  | "saveOutput": false
  | },
  | "cwd": "/app/test/runs/swift-2cfdc9"
  | }

schani · 2019-05-07T19:33:30Z

JSONSchemaSupport.swift:33:41: error: use of undeclared type 'Hasher'
  | public func hash(into hasher: inout Hasher) {
  | ^~~~~~
  |  
  | Fixture threw an exception
  | {
  | "error": {
  | "command": "swiftc -o quicktype *.swift",
  | "code": 1
  | },
  | "sample": {
  | "path": "test/inputs/json/priority/combinations3.json",
  | "additionalRendererOptions": {
  | "support-linux": "false"
  | },
  | "saveOutput": false
  | },
  | "cwd": "/app/test/runs/swift-30719e"
  | }
  |  
  | JSONSchemaSupport.swift:33:41: error: use of undeclared type 'Hasher'
  | public func hash(into hasher: inout Hasher) {
  | ^~~~~~
  |  
  | Fixture threw an exception
  | {
  | "error": {
  | "command": "swiftc -o quicktype *.swift",
  | "code": 1
  | },
  | "sample": {
  | "path": "test/inputs/json/priority/combinations4.json",
  | "additionalRendererOptions": {
  | "support-linux": "false"
  | },
  | "saveOutput": false
  | },
  | "cwd": "/app/test/runs/swift-8ba570"
  | }

schani · 2019-05-07T21:06:20Z

JSONSchemaSupport.swift:33:41: error: use of undeclared type 'Hasher'
  | public func hash(into hasher: inout Hasher) {
  | ^~~~~~
  |  
  | Fixture threw an exception
  | {
  | "error": {
  | "command": "swiftc -o quicktype *.swift",
  | "code": 1
  | },
  | "sample": {
  | "path": "test/inputs/json/priority/combinations3.json",
  | "additionalRendererOptions": {
  | "support-linux": "false"
  | },
  | "saveOutput": false
  | },
  | "cwd": "/app/test/runs/swift-511bfd"
  | }

…o/new/multi-file-output # Conflicts: # src/quicktype-core/language/Swift.ts

…files

schani

Can this still produce one-file output? That should be the default. We have many users of quicktype with Swift who I'm sure depend on the current behavior. Sorry I didn't point this out earlier.

schani · 2019-05-09T17:05:32Z

JSONSchemaSupport.swift:33:41: error: use of undeclared type 'Hasher'
  | public func hash(into hasher: inout Hasher) {
  | ^~~~~~
  |  
  | Fixture threw an exception
  | {
  | "error": {
  | "command": "swiftc -o quicktype *.swift",
  | "code": 1
  | },
  | "sample": {
  | "path": "test/inputs/json/priority/combinations4.json",
  | "additionalRendererOptions": {
  | "support-linux": "false"
  | },
  | "saveOutput": false
  | },
  | "cwd": "/app/test/runs/swift-c28655"
  | }
  | [object Object]
  | at /app/test/test.ts:68:17
  | at step (/app/test/test.ts:32:23)
  | at Object.throw (/app/test/test.ts:13:53)
  | at rejected (/app/test/test.ts:5:65)
  | at <anonymous>
  | at process._tickDomainCallback (internal/process/next_tick.js:229:7)
  |  
  | JSONSchemaSupport.swift:33:41: error: use of undeclared type 'Hasher'
  | public func hash(into hasher: inout Hasher) {
  | ^~~~~~
  |  
  | Fixture threw an exception
  | {
  | "error": {
  | "command": "swiftc -o quicktype *.swift",
  | "code": 1
  | },
  | "sample": {
  | "path": "test/inputs/json/priority/combinations3.json",
  | "additionalRendererOptions": {
  | "support-linux": "false"
  | },
  | "saveOutput": false
  | },
  | "cwd": "/app/test/runs/swift-a4533e"
  | }

MrRooni · 2019-05-09T17:11:10Z

@schani I should be able to make single file output the default, yes. I'll get that fixed up. Thanks for posting those errors. I'll be interested in seeing how the latest push works, those tests all pass locally for me.

This reverts commit 2e965c6.

This reverts commit 5a0381c.

schani · 2019-05-10T05:17:09Z

quicktype.swift:339:22: error: invalid redeclaration of 'codableTask(with:completionHandler:)'
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:184:22: note: 'codableTask(with:completionHandler:)' previously declared here
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:505:22: error: invalid redeclaration of 'codableTask(with:completionHandler:)'
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:184:22: note: 'codableTask(with:completionHandler:)' previously declared here
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:630:22: error: invalid redeclaration of 'codableTask(with:completionHandler:)'
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:184:22: note: 'codableTask(with:completionHandler:)' previously declared here
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:831:22: error: invalid redeclaration of 'codableTask(with:completionHandler:)'
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:184:22: note: 'codableTask(with:completionHandler:)' previously declared here
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:1077:22: error: invalid redeclaration of 'codableTask(with:completionHandler:)'
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:184:22: note: 'codableTask(with:completionHandler:)' previously declared here
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:1271:22: error: invalid redeclaration of 'codableTask(with:completionHandler:)'
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:184:22: note: 'codableTask(with:completionHandler:)' previously declared here
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:1425:22: error: invalid redeclaration of 'codableTask(with:completionHandler:)'
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:184:22: note: 'codableTask(with:completionHandler:)' previously declared here
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:1620:22: error: invalid redeclaration of 'codableTask(with:completionHandler:)'
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:184:22: note: 'codableTask(with:completionHandler:)' previously declared here
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:1866:22: error: invalid redeclaration of 'codableTask(with:completionHandler:)'
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:184:22: note: 'codableTask(with:completionHandler:)' previously declared here
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:2020:22: error: invalid redeclaration of 'codableTask(with:completionHandler:)'
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:184:22: note: 'codableTask(with:completionHandler:)' previously declared here
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:2179:22: error: invalid redeclaration of 'codableTask(with:completionHandler:)'
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:184:22: note: 'codableTask(with:completionHandler:)' previously declared here
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:2509:22: error: invalid redeclaration of 'codableTask(with:completionHandler:)'
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:184:22: note: 'codableTask(with:completionHandler:)' previously declared here
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:2808:22: error: invalid redeclaration of 'codableTask(with:completionHandler:)'
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  | quicktype.swift:184:22: note: 'codableTask(with:completionHandler:)' previously declared here
  | fileprivate func codableTask<T: Codable>(with url: URL, completionHandler: @escaping (T?, URLResponse?, Error?) -> Void) -> URLSessionDataTask {
  | ^
  |  
  | Fixture threw an exception
  | {
  | "error": {
  | "command": "swiftc -o quicktype main.swift quicktype.swift",
  | "code": 1
  | },
  | "sample": {
  | "path": "test/inputs/json/priority/combinations1.json",
  | "additionalRendererOptions": {
  | "url-session": "true"
  | },
  | "saveOutput": false
  | },
  | "cwd": "/app/test/runs/swift-eb5a9b"
  | }

schani · 2019-05-10T14:25:30Z

Command failed
  | {
  | "command": "diff -Naur quicktype.swift.expected quicktype.swift > /dev/null 2>&1",
  | "code": 1,
  | "cwd": "/app/test/runs/swift-01855a"
  | }
  | Fixture threw an exception
  | {
  | "error": {
  | "command": "diff -Naur quicktype.swift.expected quicktype.swift > /dev/null 2>&1",
  | "code": 1,
  | "cwd": "/app/test/runs/swift-01855a"
  | },
  | "sample": {
  | "path": "test/inputs/json/priority/bug863.json",
  | "additionalRendererOptions": {},
  | "saveOutput": true
  | },
  | "cwd": "/app/test/runs/swift-01855a"
  | }

What failed here is another test we do: It generates JSON Schema from the input JSON, and then it generates Swift from the JSON Schema, and diffs that Swift output with the one coming directly from the input JSON. Ideally those should be identical, but here's a case where they differ. Could you look into that, please? As you can see in languages.ts there's a long list of inputs in skipDiffViaSchema that we already exempt from that test because it's a bit brittle (in the case of Swift it's mostly issues with date/time).

MrRooni · 2019-05-10T14:39:15Z

I'm on it, thanks @schani

schani · 2019-05-10T17:14:17Z

Here's the diff.

One thing that jumps out right away is that the header

+// To parse the JSON, add this file to your project and do:
+//
+//   let dataClass = try DataClass(json)

is added multiple times per file. That should be fixed. I haven't looked at it in more detail apart from that.

…o/new/multi-file-output

…file

schani · 2019-05-18T13:50:39Z

Awesome, thank you!

MrRooni added 8 commits May 6, 2019 13:01

Stepping stone

c34e7e5

Fix a build error

2a1498d

Put the encoder/decoder helper functions into a supporting file

ff61903

Handle objects with no properties

fe01b7f

Make “description” a keyword for the Swift renderer

94fb4d7

It’s not strictly true unless you also specify Objective-C support, but harmless nonetheless.

Make sure to import Foundation for enums and unions

eaecb8b

Give the top level aliases the same access level as the rest of the file

a5b3a98

Move the alias, array, and map emitters into the helper file

b563367

MrRooni added 2 commits May 7, 2019 08:35

Merge branch 'master' of github.com:quicktype/quicktype into swift/ro…

36fc2ac

…o/new/multi-file-output # Conflicts: # src/quicktype-core/language/Swift.ts

Manually repair merge conflict

544a6bd

MrRooni added 2 commits May 7, 2019 14:37

Get rid of a file we don’t need anymore

2e965c6

Fix the Swift tests to reflect their new reality

5a0381c

Correct some of the code generation in the JSONSchemaSupport.swift file

aca272f

MrRooni added 7 commits May 7, 2019 18:42

More test fixes

147196f

Handle multiple objects with case-insensitive matching names

075435f

Add support for emitting a line once

90a2097

Merge branch 'master' of github.com:quicktype/quicktype into swift/ro…

5a19f02

…o/new/multi-file-output # Conflicts: # src/quicktype-core/language/Swift.ts

Manually repair merge conflict

4f49725

Fix the header renderer

b668760

Put a warning in the header about the generated nature of the source …

2d165be

…files

schani requested changes May 9, 2019

View reviewed changes

Comment thread build/quicktype-core/package.in.json Outdated

Comment thread src/quicktype-core/Renderer.ts Outdated

Comment thread src/quicktype-core/Renderer.ts Outdated

MrRooni added 3 commits May 9, 2019 11:49

Replace mistaken removal of YAML

cccee5b

Add a clarifying comment

63cc340

No need to toString() toLowerCase()

c2a78d2

MrRooni added 7 commits May 9, 2019 19:39

Add an option for Swift 5 support

aaf3294

Fix a spelling mistake in a comment

74b4810

Emit a single Swift file by default

b85ae52

Revert "Get rid of a file we don’t need anymore"

24a2c71

This reverts commit 2e965c6.

Revert "Fix the Swift tests to reflect their new reality"

61eb3e5

This reverts commit 5a0381c.

Add the new header comment to the test quicktype.swift file

f06342d

Remove the date generated header comment

44d2aa1

MrRooni added 2 commits May 10, 2019 09:35

Correct the URL session output

dbfd27c

Repair Alamofire output and add some structure to the output file

2ce4243

MrRooni added 4 commits May 10, 2019 11:20

Small formatting changes

a933eb6

Clean up some comments

a674cb0

No need to toString()

23f0f9f

Add bug863.json to the skipped diff testing

3248825

MrRooni added 4 commits May 17, 2019 13:21

Merge branch 'master' of github.com:quicktype/quicktype into swift/ro…

0c82a1e

…o/new/multi-file-output

In single-file mode output all the comments to the top of the single …

5adeb2f

…file

Minor formatting change

af0b72f

=== not ==

4c7f291

schani merged commit 53fc1c6 into glideapps:master May 18, 2019

MrRooni deleted the swift/roo/new/multi-file-output branch May 18, 2019 17:05

Uh oh!

Uh oh!

Conversation

MrRooni commented May 7, 2019

Reason to Be

CHANGELOG Entry

Thought Process

How To Test

Possible Impacts

Uh oh!

MrRooni commented May 7, 2019

Uh oh!

schani commented May 7, 2019

Uh oh!

schani commented May 7, 2019

Uh oh!

schani commented May 7, 2019

Uh oh!

schani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

schani commented May 9, 2019

Uh oh!

MrRooni commented May 9, 2019

Uh oh!

schani commented May 10, 2019

Uh oh!

schani commented May 10, 2019

Uh oh!

MrRooni commented May 10, 2019

Uh oh!

schani commented May 10, 2019

Uh oh!

schani commented May 18, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants